The System Maintenance Tools are provided for Enterprise admins to perform specialized activities directly (and only) from the servers hosting Pyramid services. There are five functions:
- Multi-Factor Authentication Token Clearance:Fail safe for enterprise admins to clear their own MFA tokens in the event theirs are lost or corrupted.
- Repository Database Password Reset: Re-key and encrypt a new database password for the database repository if it is changed.
- Test Network:Monitor all the server, send a ping with max timeout to all services if we think that there is a network issue that will prove or disprove them.
- Clean Unused Files: delete temp files that other processes might have missed.
- Upgrade Content: upgrade database files from old versions. This process should run automatically on upgrade, but might need to be run again for some bugs.
Given the sensitive nature of these functions, direct access to the host servers should be carefully guarded and monitored - to ensure only authorized admins have access to these tools.
Accessing Maintenance Tools
The tools are located in the following directory:
Windows:
{install directory}\core\maintenance\run.bat
Linux:
{install directory}/core/maintenance/run.sh
Once the tool is launched, you need to:
- Provide the currently recorded password for the database (even if you plan to change it).
- Provide the username of an enterprise admin in Pyramid
- Provide the user's password
Without these items the tools are inoperable.
Clearing the MFA Token
- Choose "2" from the menu
- Supply the name of a user
- ENTER to apply the change
The affected user should fully logout of the app. Alternatively, revoke all their sessions form the admin.
Re-keying the Database Password
- Choose "1" from the menu
- Supply the new password
- ENTER to apply the change
All services need to be recycled to access the new password.